Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for 2024.1 #15915

Merged
merged 4 commits into from
Dec 14, 2023
Merged

Documentation for 2024.1 #15915

merged 4 commits into from
Dec 14, 2023

Conversation

seanbudd
Copy link
Member

@seanbudd seanbudd commented Dec 13, 2023

Must be a squash merge

Changes from this PR to the previous release:

  • Files to check: user_docs/en/userGuide.t2t, user_docs/en/changes.t2t developerGuide.t2t
  • Compare this branch to the previous release
  • Comparison command:
    git diff release-2023.3...documentationFor2024.1 -- "**/en/*.t2t" "**/developerGuide.t2t"

Common mistakes to check for:

  • Issue/PR reference in changes file is incorrect
  • Incorrect spelling.
  • Lists not terminated with a final - on a new line, matching indentation
  • List items not indented by a multiple of 2 spaces (regex ^ ( )*-)
  • Single grave marks ` instead of double grave marks `` (regex [^`]`[^`])
  • Shortcuts added without code markdown, use two 'grave' characters (e.g. ``NVDA+d``)
  • Double spaces (regex [^ ] )
  • Inconsistent use of single vs double quote. (regex ' )

@seanbudd seanbudd requested a review from a team as a code owner December 13, 2023 01:25
@seanbudd seanbudd changed the base branch from master to beta December 13, 2023 01:26
@seanbudd seanbudd closed this Dec 13, 2023
@seanbudd seanbudd reopened this Dec 13, 2023
@seanbudd seanbudd requested a review from a team as a code owner December 13, 2023 01:27
@seanbudd seanbudd requested review from Qchristensen and removed request for a team December 13, 2023 01:27
@seanbudd seanbudd changed the title Documentation for2024.1 Documentation for 2024.1 Dec 13, 2023
@seanbudd seanbudd added this to the 2024.1 milestone Dec 13, 2023
Qchristensen
Qchristensen previously approved these changes Dec 13, 2023
Copy link
Member

@Qchristensen Qchristensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Lots in here for users.

@CyrilleB79
Copy link
Collaborator

This PR can also be an opportunity to add credit for people or organization that have not claimed it until now:

As a reminder, crediting contributors is not mandatory and is made upon contributor's request.
My personal point of view is that credit is not only a way to recognize the work that has been done. But it's also an easy way to provide a contact for people working or investigating the same features.

Could any of you reply back if you wish to be credited for these items? You may also indicate if you do not wish to be credited, so that I do not bother you anymore with credit.

Also the following items have not been credited although their author usually have already claimed credit:

@seanbudd, @michaelDCurran, it may be interesting to modify the PR template to add a question or a check point regarding credit, so that we can be sure that, if people do not claim credit, it's not an oversight.

@LeonarddeR
Copy link
Collaborator

* [Update SCons to version 4.5.2 #15529](https://github.com/nvaccess/nvda/pull/15529) (@LeonarddeR)

Thanks. Would be most grateful if you could fix this up.

@alexmoon
Copy link
Contributor

I don't need credit.

@burmancomp
Copy link
Contributor

No credits.

@codeofdusk
Copy link
Contributor

Re #15512, feel free to credit me.

@seanbudd seanbudd merged commit ec8951e into beta Dec 14, 2023
1 check was pending
@seanbudd seanbudd deleted the documentationFor2024.1 branch December 14, 2023 22:50
Adriani90 pushed a commit to Adriani90/nvda that referenced this pull request Mar 13, 2024
Update documentations and release blurb for 2024.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants